com.doclinx.ftxml
Class CatalogSearchException

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--com.doclinx.ftxml.CatalogSearchException
All Implemented Interfaces:
java.io.Serializable

public final class CatalogSearchException
extends java.lang.Exception

This class comprises the exception thrown by the CatalogSearch class. All CatalogSearch methods either return a value or void if OK. All errors are returned thrown with a message and the error code available to the catching code.

See Also:
CatalogSearch, Serialized Form

Constructor Summary
CatalogSearchException()
          Default constructor -- should never see this exception.
CatalogSearchException(int iErrorCode)
          CatalogSearch exception constructor with indicated error code.
CatalogSearchException(int iErrorCode, java.lang.Throwable rootCause)
          CatalogSearch exception constructor with indicated error code + root cause
CatalogSearchException(java.lang.String sErrorMessage)
          CatalogSearch exception with only a message.
CatalogSearchException(java.lang.String sErrorMessage, int iErrorCode)
          CatalogSearch exception constructor with indicated error code + message.
CatalogSearchException(java.lang.String sErrorMessage, int iErrorCode, java.lang.Throwable rootCause)
          CatalogSearch exception constructor with indicated error code + message + root cause
CatalogSearchException(java.lang.String sErrorMessage, java.lang.Throwable rootCause)
          CatalogSearch exception with only a message + root cause
 
Method Summary
 int getErrorCode()
           
 java.lang.String getErrorMessage(int iErrorCode)
           
 java.lang.String getErrorMessage(java.lang.String sMessage, int iErrorCode)
           
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CatalogSearchException

public CatalogSearchException()
Default constructor -- should never see this exception.

Throws:
**none**

CatalogSearchException

public CatalogSearchException(java.lang.String sErrorMessage)
CatalogSearch exception with only a message.

Parameters:
sErrorMessage - Error message.
Throws:
**none**

CatalogSearchException

public CatalogSearchException(java.lang.String sErrorMessage,
                              java.lang.Throwable rootCause)
CatalogSearch exception with only a message + root cause

Parameters:
sErrorMessage - Error message.
rootCause - Throwable that caused this exception
Throws:
**none**

CatalogSearchException

public CatalogSearchException(int iErrorCode)
CatalogSearch exception constructor with indicated error code.

Parameters:
iErrorCode - Code number of error, always < 0.
Throws:
**none**
See Also:
error codes values.

CatalogSearchException

public CatalogSearchException(int iErrorCode,
                              java.lang.Throwable rootCause)
CatalogSearch exception constructor with indicated error code + root cause

Parameters:
iErrorCode - Code number of error, always < 0.
rootCause - Throwable that caused this exception
Throws:
**none**
See Also:
error codes values.

CatalogSearchException

public CatalogSearchException(java.lang.String sErrorMessage,
                              int iErrorCode)
CatalogSearch exception constructor with indicated error code + message.

Parameters:
iErrorCode - Code number of error, always < 0.
sErrorMessage - Additional message to include with code message.
Throws:
**none**
See Also:
error codes values.

CatalogSearchException

public CatalogSearchException(java.lang.String sErrorMessage,
                              int iErrorCode,
                              java.lang.Throwable rootCause)
CatalogSearch exception constructor with indicated error code + message + root cause

Parameters:
iErrorCode - Code number of error, always < 0.
sErrorMessage - Additional message to include with code message.
rootCause - Throwable that caused this exception
Throws:
**none**
See Also:
error codes values.
Method Detail

getErrorCode

public int getErrorCode()

getErrorMessage

public java.lang.String getErrorMessage(int iErrorCode)

getErrorMessage

public java.lang.String getErrorMessage(java.lang.String sMessage,
                                        int iErrorCode)